3 追蹤者

類別 yii\widgets\Pjax

繼承關係yii\widgets\Pjax » yii\base\Widget » yii\base\Component » yii\base\BaseObject
實作介面yii\base\Configurable, yii\base\ViewContextInterface
自版本2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/widgets/Pjax.php

Pjax 小工具整合了 pjax jQuery 外掛程式。

Pjax 僅處理由其 begin()end() 呼叫之間所包含的內容,稱為小工具的主體內容。預設情況下,主體內容中的任何連結點擊或表單提交(對於那些具有 data-pjax 屬性的表單)都將觸發 AJAX 請求。在回應 AJAX 請求時,Pjax 將傳送更新後的主體內容(基於 AJAX 請求)到客戶端,客戶端將以新內容替換舊內容。然後,瀏覽器的 URL 將使用 pushState 更新。整個過程無需重新載入版面配置或資源(js、css)。

您可以設定 $linkSelector 以指定哪些連結應觸發 pjax,並設定 $formSelector 以指定哪些表單提交可以觸發 pjax。

您可以透過將 data-pjax="0" 屬性新增至此連結,來停用容器內特定連結的 pjax 功能。

以下範例示範如何將 Pjax 與 yii\grid\GridView 小工具一起使用,以便可以透過 pjax 完成網格分頁、排序和篩選

use yii\widgets\Pjax;

Pjax::begin();
echo GridView::widget([...]);
Pjax::end();

公共屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$autoIdPrefix string 自動產生的小工具 ID 的前綴。 yii\widgets\Pjax
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$clientOptions array 要傳遞給 pjax JS 外掛程式的其他選項。 yii\widgets\Pjax
$enablePushState boolean 是否啟用 push state。 yii\widgets\Pjax
$enableReplaceState boolean 是否啟用 replace state。 yii\widgets\Pjax
$formSelector string|null|false 表單的 jQuery 選擇器,其提交應觸發 pjax 請求。 yii\widgets\Pjax
$id string|null 小工具的 ID。 yii\base\Widget
$linkSelector string|null|false 連結的 jQuery 選擇器,這些連結應觸發 pjax 請求。 yii\widgets\Pjax
$options array 小工具容器標籤的 HTML 屬性。 yii\widgets\Pjax
$scrollTo boolean|integer 收到 pjax 回應時如何滾動頁面。 yii\widgets\Pjax
$submitEvent string 將觸發表單處理程序的 jQuery 事件。 yii\widgets\Pjax
$timeout integer Pjax 超時設定(以毫秒為單位)。 yii\widgets\Pjax
$view yii\web\View 可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
$viewPath string 包含此小工具視圖檔案的目錄。 yii\base\Widget

公共方法

隱藏繼承的方法

方法 描述 定義於
__call() 呼叫指定的非類別方法。 yii\base\Component
__clone() 在透過複製現有物件建立物件後,會呼叫此方法。 yii\base\Component
__construct() 建構子。 yii\base\BaseObject
__get() 傳回元件屬性的值。 yii\base\Component
__isset() 檢查屬性是否已設定,即已定義且非 null。 yii\base\Component
__set() 設定元件屬性的值。 yii\base\Component
__unset() 將元件屬性設定為 null。 yii\base\Component
afterRun() 此方法在小工具執行後立即調用。 yii\base\Widget
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到元件。 yii\base\Component
beforeRun() 此方法在小工具執行前立即調用。 yii\base\Widget
begin() 開始一個小工具。 yii\base\Widget
behaviors() 傳回此元件應表現為的行為列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
detachBehavior() 從元件中分離行為。 yii\base\Component
detachBehaviors() 從元件中分離所有行為。 yii\base\Component
end() 結束一個小工具。 yii\base\Widget
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
getBehavior() 傳回指定的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getId() 傳回小工具的 ID。 yii\base\Widget
getView() 傳回可用於呈現視圖或視圖檔案的視圖物件。 yii\base\Widget
getViewPath() 傳回包含此小工具檢視檔的目錄。 yii\base\Widget
hasEventHandlers() 傳回一個值,指出是否有任何處理常式附加到指定的事件。 yii\base\Component
hasMethod() 傳回一個值,指出是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指出是否已為此元件定義屬性。 yii\base\Component
init() 初始化物件。 yii\widgets\Pjax
off() 從此元件卸離現有的事件處理常式。 yii\base\Component
on() 將事件處理常式附加到事件。 yii\base\Component
registerClientScript() 註冊所需的 JavaScript。 yii\widgets\Pjax
render() 渲染檢視。 yii\base\Widget
renderFile() 渲染檢視檔。 yii\base\Widget
run() 執行小工具。 yii\widgets\Pjax
setId() 設定小工具的 ID。 yii\base\Widget
setView() 設定此小工具要使用的檢視物件。 yii\base\Widget
trigger() 觸發事件。 yii\base\Component
widget() 建立小工具實例並執行它。 yii\base\Widget

受保護的方法

隱藏繼承的方法

方法 描述 定義於
requiresPjax() yii\widgets\Pjax

事件

隱藏繼承的事件

事件 類型 描述 定義於
EVENT_AFTER_RUN yii\base\WidgetEvent 在執行小工具之後立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在執行小工具之前立即引發的事件。(自版本 2.0.11 起可用) yii\base\Widget
EVENT_INIT yii\base\Event 透過 init() 初始化小工具時觸發的事件。(自版本 2.0.11 起可用) yii\base\Widget

屬性詳細資訊

隱藏繼承的屬性

$autoIdPrefix public static property

自動產生的小工具 ID 的前綴。

public static string $autoIdPrefix 'p'
$clientOptions public property

要傳遞給 pjax JS 外掛程式的其他選項。請參閱 pjax 專案頁面 以取得可用的選項。

public array $clientOptions null
$enablePushState public property

是否啟用 push state。

public boolean $enablePushState true
$enableReplaceState public property

是否啟用 replace state。

$formSelector public property

表單的 jQuery 選擇器,其提交應觸發 pjax 請求。如果未設定,則 Pjax 封閉內容中具有 data-pjax 屬性的所有表單都將觸發 pjax 請求。如果設定為 false,則不會註冊任何程式碼來處理表單。請注意,如果對 pjax 請求的回應是完整頁面,則將再次傳送一般請求。

$linkSelector public property

連結的 jQuery 選擇器,其應觸發 pjax 請求。如果未設定,則 Pjax 封閉內容中的所有連結都將觸發 pjax 請求。如果設定為 false,則不會註冊任何程式碼來處理連結。請注意,如果對 pjax 請求的回應是完整頁面,則將再次傳送一般請求。

$options public property

小工具容器標籤的 HTML 屬性。以下特殊選項可被識別

  • tag:字串,容器的標籤名稱。預設為 div。此選項自版本 2.0.7 起可用。另請參閱 yii\helpers\Html::tag()

另請參閱 yii\helpers\Html::renderTagAttributes() 以取得關於如何渲染屬性的詳細資訊。

public array $options = []
$scrollTo public property

收到 pjax 回應時如何捲動頁面。如果為 false,則不會進行頁面捲動。如果您想要捲動到特定位置,請使用數字。

public boolean|integer $scrollTo false
$submitEvent public property (自版本 2.0.9 起可用)

將觸發表單處理常式的 jQuery 事件。預設為 "submit"。

public string $submitEvent 'submit'
$timeout public property

Pjax 超時設定(以毫秒為單位)。此超時設定用於發出 AJAX 請求時。如果您的伺服器速度較慢,請使用較大的數字。如果伺服器在超時時間內沒有回應,則會觸發完整頁面載入。

public integer $timeout 1000

方法詳細資訊

隱藏繼承的方法

__call() public method

定義於: yii\base\Component::__call()

呼叫指定的非類別方法。

此方法將檢查是否有任何附加的行為具有指定的名稱方法,如果有,則將執行該方法。

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當調用未知方法時,將會隱式呼叫它。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

定義於: yii\base\Component::__clone()

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為它們附加到舊物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

定義於: yii\base\BaseObject::__construct()

建構子。

預設實作會執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果子類別中覆寫了此方法,建議

  • 建構子的最後一個參數是組態陣列,例如此處的 $config
  • 在建構子的結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() public method

定義於: yii\base\Component::__get()

傳回元件屬性的值。

此方法將依以下順序檢查並採取相應措施

  • getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $component->property; 時,將會隱式呼叫它。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return mixed

屬性值或行為的屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

定義於: yii\base\Component::__isset()

檢查屬性是否已設定,即已定義且非 null。

此方法將依以下順序檢查並採取相應措施

  • setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($component->property) 時,將會隱式呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

具名屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

定義於: yii\base\Component::__set()

設定元件屬性的值。

此方法將依以下順序檢查並採取相應措施

  • setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $component->property = $value; 時,將會隱式呼叫它。

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

$value mixed

屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

定義於: yii\base\Component::__unset()

將元件屬性設定為 null。

此方法將依以下順序檢查並採取相應措施

  • setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($component->property) 時,將會隱式呼叫它。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterRun() public method (自版本 2.0.11 起可用)

定義於: yii\base\Widget::afterRun()

此方法在小工具執行後立即調用。

此方法將觸發 EVENT_AFTER_RUN 事件。此方法的傳回值將用作小工具傳回值。

如果您覆寫此方法,您的程式碼應如下所示

public function afterRun($result)
{
    $result = parent::afterRun($result);
    // your custom code here
    return $result;
}
public mixed afterRun ( $result )
$result mixed

小工具傳回結果。

return mixed

已處理的小工具結果。

                public function afterRun($result)
{
    $event = new WidgetEvent();
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_RUN, $event);
    return $event->result;
}

            
attachBehavior() public method

定義於: yii\base\Component::attachBehavior()

將行為附加到此元件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是以下其中之一

return yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

定義於: yii\base\Component::attachBehaviors()

將行為列表附加到元件。

每個行為都按其名稱編制索引,並且應該是 yii\base\Behavior 物件、指定行為類別的字串,或是用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為清單

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeRun() public method (自版本 2.0.11 起可用)

定義於: yii\base\Widget::beforeRun()

此方法在小工具執行前立即調用。

此方法將觸發 EVENT_BEFORE_RUN 事件。此方法的傳回值將決定小工具是否應繼續執行。

當覆寫此方法時,請確保您像下面這樣呼叫父類別實作

public function beforeRun()
{
    if (!parent::beforeRun()) {
        return false;
    }

    // your custom code here

    return true; // or false to not run the widget
}
public boolean beforeRun ( )
return boolean

小工具是否應繼續執行。

                public function beforeRun()
{
    $event = new WidgetEvent();
    $this->trigger(self::EVENT_BEFORE_RUN, $event);
    return $event->isValid;
}

            
begin() public static method

定義於: yii\base\Widget::begin()

開始一個小工具。

此方法建立呼叫類別的實例。它會將組態應用於建立的實例。稍後應呼叫相符的 end() 呼叫。由於某些小工具可能會使用輸出緩衝,因此 end() 呼叫應在相同的檢視中進行,以避免中斷輸出緩衝的巢狀結構。

另請參閱 end()

public static static begin ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

return yii\base\Widget

新建立的小工具實例

                public static function begin($config = [])
{
    $config['class'] = get_called_class();
    /* @var $widget Widget */
    $widget = Yii::createObject($config);
    self::$stack[] = $widget;
    return $widget;
}

            
behaviors() public method

定義於: yii\base\Component::behaviors()

傳回此元件應表現為的行為列表。

子類別可以覆寫此方法,以指定它們想要表現為的行為。

此方法的傳回值應為行為物件或組態的陣列,並依行為名稱編制索引。行為組態可以是指定行為類別的字串,或是以下結構的陣列

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

請注意,行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當使用名稱作為陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 卸離行為。匿名行為無法檢索或卸離。

在此方法中宣告的行為將自動(按需)附加到元件。

public array behaviors ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

定義於: yii\base\Component::canGetProperty()

傳回一個值,指示是否可以讀取屬性。

如果滿足以下條件,則可以讀取屬性

  • 類別具有與指定名稱相關聯的 getter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以讀取

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

定義於: yii\base\Component::canSetProperty()

傳回一個值,指示是否可以設定屬性。

如果滿足以下條件,則可以寫入屬性

  • 類別具有與指定名稱相關聯的 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫屬性(當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否可以寫入

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
自 2.0.14 版本起已棄用。在 PHP >=5.5 上,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

定義於: yii\base\Component::detachBehavior()

從元件中分離行為。

將調用行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

return yii\base\Behavior|null

已卸離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

定義於: yii\base\Component::detachBehaviors()

從元件中分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
end() public static method

定義於: yii\base\Widget::end()

結束一個小工具。

請注意,小部件的渲染結果會直接輸出。

另請參閱 begin()

public static static end ( )
return yii\base\Widget

已結束的小部件實例。

throws yii\base\InvalidCallException

如果 begin()end() 呼叫未正確巢狀

                public static function end()
{
    if (!empty(self::$stack)) {
        $widget = array_pop(self::$stack);
        $calledClass = get_called_class();
        if (Yii::$container->has($calledClass) && isset(Yii::$container->getDefinitions()[$calledClass]['class'])) {
            $calledClass = Yii::$container->getDefinitions()[$calledClass]['class'];
        }
        if (get_class($widget) === $calledClass) {
            /* @var $widget Widget */
            if ($widget->beforeRun()) {
                $result = $widget->run();
                $result = $widget->afterRun($result);
                echo $result;
            }
            return $widget;
        }
        throw new InvalidCallException('Expecting end() of ' . get_class($widget) . ', found ' . get_called_class());
    }
    throw new InvalidCallException('Unexpected ' . get_called_class() . '::end() call. A matching begin() is not found.');
}

            
ensureBehaviors() public method

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public method

定義於: yii\base\Component::getBehavior()

傳回指定的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此組件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getId() public method

定義於: yii\base\Widget::getId()

傳回小工具的 ID。

public string|null getId ( $autoGenerate true )
$autoGenerate boolean

是否在先前未設定 ID 的情況下產生 ID

return string|null

小工具的 ID。

                public function getId($autoGenerate = true)
{
    if ($autoGenerate && $this->_id === null) {
        $this->_id = static::$autoIdPrefix . static::$counter++;
    }
    return $this->_id;
}

            
getView() public method

定義於: yii\base\Widget::getView()

傳回可用於呈現視圖或視圖檔案的視圖物件。

render()renderFile() 方法將使用此視圖物件來實作實際的視圖渲染。 如果未設定,則預設為 "view" 應用程式組件。

public yii\web\View getView ( )
return yii\web\View

可用於呈現視圖或視圖檔案的視圖物件。

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

定義於: yii\base\Widget::getViewPath()

傳回包含此小工具檢視檔的目錄。

預設實作會傳回包含小部件類別檔案的目錄下的 'views' 子目錄。

public string getViewPath ( )
return string

包含此小工具視圖檔案的目錄。

                public function getViewPath()
{
    $class = new ReflectionClass($this);
    return dirname($class->getFileName()) . DIRECTORY_SEPARATOR . 'views';
}

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指出是否有任何處理常式附加到指定的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

是否有任何處理常式附加到事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義於: yii\base\Component::hasMethod()

傳回一個值,指出是否已定義方法。

如果滿足以下條件,則定義方法

  • 類別具有具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法

return boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義於: yii\base\Component::hasProperty()

傳回一個值,指出是否已為此元件定義屬性。

如果滿足以下條件,則定義屬性

  • 類別具有與指定名稱關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數(當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否已定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

初始化物件。

此方法在建構子的末尾呼叫。 預設實作將觸發 EVENT_INIT 事件。

public void init ( )

                public function init()
{
    parent::init();
    if (!isset($this->options['id'])) {
        $this->options['id'] = $this->getId();
    }
    if ($this->requiresPjax()) {
        ob_start();
        ob_implicit_flush(false);
        $view = $this->getView();
        $view->clear();
        $view->beginPage();
        $view->head();
        $view->beginBody();
        if ($view->title !== null) {
            echo Html::tag('title', Html::encode($view->title));
        }
    } else {
        $options = $this->options;
        $tag = ArrayHelper::remove($options, 'tag', 'div');
        echo Html::beginTag($tag, array_merge([
            'data-pjax-container' => '',
            'data-pjax-push-state' => $this->enablePushState,
            'data-pjax-replace-state' => $this->enableReplaceState,
            'data-pjax-timeout' => $this->timeout,
            'data-pjax-scrollto' => $this->scrollTo,
        ], $options));
    }
}

            
off() public method

定義於: yii\base\Component::off()

從此元件卸離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理常式,而使用與此萬用字元匹配的純名稱註冊的處理常式將保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱

$handler callable|null

要移除的事件處理常式。 如果為 null,則會移除附加到具名事件的所有處理常式。

return boolean

如果找到並分離處理常式

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

定義於: yii\base\Component::on()

將事件處理常式附加到事件。

事件處理常式必須是有效的 PHP 回呼。 以下是一些範例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件處理常式必須使用以下簽名定義,

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件相關聯的參數。

自 2.0.14 起,您可以將事件名稱指定為萬用字元模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler callable

事件處理常式

$data mixed

事件觸發時要傳遞給事件處理常式的資料。 叫用事件處理常式時,可以透過 yii\base\Event::$data 存取此資料。

$append boolean

是否將新的事件處理常式附加到現有處理常式列表的末尾。 如果為 false,則新的處理常式將插入到現有處理常式列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
registerClientScript() public method

註冊所需的 JavaScript。

public void registerClientScript ( )

                public function registerClientScript()
{
    $id = $this->options['id'];
    $this->clientOptions['push'] = $this->enablePushState;
    $this->clientOptions['replace'] = $this->enableReplaceState;
    $this->clientOptions['timeout'] = $this->timeout;
    $this->clientOptions['scrollTo'] = $this->scrollTo;
    if (!isset($this->clientOptions['container'])) {
        $this->clientOptions['container'] = "#$id";
    }
    $options = Json::htmlEncode($this->clientOptions);
    $js = '';
    if ($this->linkSelector !== false) {
        $linkSelector = Json::htmlEncode($this->linkSelector !== null ? $this->linkSelector : '#' . $id . ' a');
        $js .= "jQuery(document).pjax($linkSelector, $options);";
    }
    if ($this->formSelector !== false) {
        $formSelector = Json::htmlEncode($this->formSelector !== null ? $this->formSelector : '#' . $id . ' form[data-pjax]');
        $submitEvent = Json::htmlEncode($this->submitEvent);
        $js .= "\njQuery(document).off($submitEvent, $formSelector).on($submitEvent, $formSelector, function (event) {jQuery.pjax.submit(event, $options);});";
    }
    $view = $this->getView();
    PjaxAsset::register($view);
    if ($js !== '') {
        $view->registerJs($js);
    }
}

            
render() public method

定義於: yii\base\Widget::render()

渲染檢視。

要渲染的視圖可以使用以下格式之一指定

  • 路徑別名(例如 "@app/views/site/index");
  • 應用程式內的絕對路徑(例如 "//site/index"):視圖名稱以雙斜線開頭。 實際的視圖檔案將在應用程式的 視圖路徑 下尋找。
  • 模組內的絕對路徑(例如 "/site/index"):視圖名稱以單斜線開頭。 實際的視圖檔案將在目前活動模組的 視圖路徑 下尋找。
  • 相對路徑(例如 "index"):實際的視圖檔案將在 $viewPath 下尋找。

如果視圖名稱不包含檔案副檔名,它將使用預設的 .php

public string render ( $view, $params = [] )
$view string

視圖名稱。

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function render($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
renderFile() public method

定義於: yii\base\Widget::renderFile()

渲染檢視檔。

public string renderFile ( $file, $params = [] )
$file string

要渲染的視圖檔案。 這可以是檔案路徑或 路徑別名

$params array

應在視圖中提供的參數(名稱-值對)。

return string

渲染結果。

throws yii\base\InvalidArgumentException

如果視圖檔案不存在。

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
requiresPjax() protected method

protected boolean requiresPjax ( )
return boolean

目前請求是否需要來自此小部件的 pjax 回應

                protected function requiresPjax()
{
    $headers = Yii::$app->getRequest()->getHeaders();
    return $headers->get('X-Pjax') && explode(' ', $headers->get('X-Pjax-Container'))[0] === '#' . $this->options['id'];
}

            
run() public method

執行小工具。

public string|void run ( )
return string|void

渲染結果可以直接 "echoed" 或作為字串傳回

                public function run()
{
    if (!$this->requiresPjax()) {
        echo Html::endTag(ArrayHelper::remove($this->options, 'tag', 'div'));
        $this->registerClientScript();
        return;
    }
    $view = $this->getView();
    $view->endBody();
    $view->endPage(true);
    $content = ob_get_clean();
    // only need the content enclosed within this widget
    $response = Yii::$app->getResponse();
    $response->clearOutputBuffers();
    $response->setStatusCode(200);
    $response->format = Response::FORMAT_HTML;
    $response->content = $content;
    $response->headers->setDefault('X-Pjax-Url', Yii::$app->request->url);
    Yii::$app->end();
}

            
setId() public method

定義於: yii\base\Widget::setId()

設定小工具的 ID。

public void setId ( $value )
$value string

小部件的 ID。

                public function setId($value)
{
    $this->_id = $value;
}

            
setView() public method

定義於: yii\base\Widget::setView()

設定此小工具要使用的檢視物件。

public void setView ( $view )
$view yii\base\View

可用於呈現視圖或視圖檔案的視圖物件。

                public function setView($view)
{
    $this->_view = $view;
}

            
trigger() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。 它會叫用事件的所有附加處理常式,包括類別層級的處理常式。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱

$event yii\base\Event|null

事件實例。 如果未設定,將會建立預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
widget() public static method

定義於: yii\base\Widget::widget()

建立小工具實例並執行它。

小部件渲染結果由此方法傳回。

public static string widget ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值對

return string

小部件的渲染結果。

throws Throwable

                public static function widget($config = [])
{
    ob_start();
    ob_implicit_flush(false);
    try {
        /* @var $widget Widget */
        $config['class'] = get_called_class();
        $widget = Yii::createObject($config);
        $out = '';
        if ($widget->beforeRun()) {
            $result = $widget->run();
            $out = $widget->afterRun($result);
        }
    } catch (\Exception $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    } catch (\Throwable $e) {
        // close the output buffer opened above if it has not been closed already
        if (ob_get_level() > 0) {
            ob_end_clean();
        }
        throw $e;
    }
    return ob_get_clean() . $out;
}